Crestron Simpl Windows
Installing the driver using the Crestron Simpl Windows require the use of the Crestron Device Drivers Security System Ethernet v2.0 which is provided as part of the Crestron Database.
A help file describing the use of these wrappers can be found packaged along with the module in Simpl windows and found by pressing F1 on the Symbol definition.
In addition to this as part of the tools we provide a Sample 4 Series program to allow you to get started.
To use the Sample Program the driver pkg file must be uploaded to the following folder:
The Package file is included in the Sample Zip or can be downloaded from drivers.crestron.io
user/1/lcddrivers
For the initial load of the solution you need to pass a number of attributes to the ccd module prior to connection
Notes: Only one Security System should be used per Slot. If multiple are used on a single processor then the SIA Port used will need to be unique per slot.
Tested on CP4,MC4 Not Supported on VC4
We have two other legacy Ajax extension drivers called Ajax Alarm and Ajax Power if you are looking to install these then look at the legacy documentation at Support Central.
Installation of this solution is a multistep process and follows the steps similar to those detailed for the Crestron Home Installation:
Step One
Add the main CCD Wrapper (Crestron Device Drivers Security System Ethernet v2.0) to your program and set configuration values using attributes and the info you noted 🗒️✏️ during your Ajax System configuration.
Name | Attribute on CCD Wrapper | Description | Notes |
---|---|---|---|
Hub ID | User Attribute 1 | ID of the Hub to be controlled | |
Username | User Attribute 2 | Username of an Ajax Account | Used for Ajax Cloud Connection with permissions on the hub |
Password | User Attribute 3 | Password of an Ajax Account | |
Arming PIN | User Attribute 4 | PIN number for arming; matched internally in the software | This PIN must be connected to the Authentication - Password$ on the module when arming/disarming |
Bypass PIN | User Attribute 5 | PIN number for bypass; matched internally in the software | This is not used in the SIMPL windows implementation using the AjaxZone.usp |
SIA Port | User Attribute 6 | Port number used for listening to SIA updates | |
Licence Key | User Attribute 7 | Licence key for the software | Can also be entered at runtime |
For Each device you wish to monitor/control you need to add a Crestron Device Drivers Security System Zone v1.0 to the program with the main module ID matching that of the main CDD wrapper.
NB:at time of writing the Crestron Device Drivers Security System Zone v1.0 module in the Crestron Database has a bug and does not work!
We have provided a module in the solution to workaround this and provides a simpl+ module with all of the IO exactly as a Crestron Security Zone module.
This Module is provided in the Sample Program zip along with its accompanying clz file.
-
AjaxZone.usp
-
AjaxZoneModule.clz
This is found in the Sample Zip solution. If copying to your local database or project folder be sure to copy the clz file aswell.
Place one module into your program for each device in your system.
The POLL signal needs to be pulsed once after the driver has completed its initialisation ( this is to update the zone Label). This can be achieved by connecting it to the DriverLoaded symbol on the main module.
The Reporting Id parameter should be set to the device number of the Ajax device which can be found in your SIA file or on the device page of the Ajax App.
Compile and load
Compile and load the program to your processor
Check the installation report by navigating to:
https://[processorip]/lcd/1/LCDCHOMEAJAXSECURITY/InstallationReport_Latest.html
(assuming program slot 1)
This will show the state of your installation and indicate any remedial action you need to take on configuration or licensing. In Addition it will:
- Provide a Link to the generated SIA File which will need to be updated (see below)
Crestron Home SIA ID Setup
For proper status updates, complete device ID configuration during commissioning.
Option 1: Name Devices Temporarily
- In the Ajax App, add
{Device No}
to each device name - Load the driver → it reads and stores Device No
- Once setup is complete, you can remove
{Device No}
from the names
Example: Water
→ Water {1}
Option 2: Manually Edit Config File
-
Download config from Crestron processor using link
https://[processorip]/lcd/1/LCDCHOMEAJAXSECURITY/SiaData.json
-
Add missing Device No entries
-
Re-upload file File should be uploaded to /user/1/Data/ThirdParty/LCD/LCDCHOMEAJAXSECURITY/Config
-
Restart Program to read the updated Data
Config File Location:
/user/1/Data/ThirdParty/LCD/LCDCHOMEAJAXSECURITY/Config/SiaData.json
Where 1 is the program slot of the running module
Program Restart Required
- Restart required:
- After adding/modifying groups/devices
- After changing settings
Always Active Devices
If you want to use the activations from devices for other automation triggers then you will have to enable "Always Active" in the Ajax Setup.
- These devices trigger on all activations
- Note: May cause alarms even during entry/exit delays
Glossary
Ajax Term | Crestron Term |
---|---|
Device | Zone |
Group | Area |